Skip to content

Update banner to use RTD projects subdirs #3145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 10, 2025
Merged

Update banner to use RTD projects subdirs #3145

merged 1 commit into from
Nov 10, 2025

Conversation

@oraNod
Copy link
Contributor

@oraNod oraNod commented Oct 17, 2025

Javascript for the banner doesn't work on RTD unless we add the /projects/ subdirectory. I updated all references in the banner too.

@oraNod oraNod requested a review from samccann October 17, 2025 09:37
@oraNod oraNod added the RTD migration Related to the migration of content to readthedocs label Oct 17, 2025
oraNod
oraNod commented Oct 17, 2025
View reviewed changes
docs/docsite/.templates/banner.html
msg += '<br><p><strong>Important:</strong> The ansible-core 2.19/Ansible 12 release has made <b>significant templating changes that might require you to update playbooks and roles</b>. The templating changes enable reporting of numerous problematic behaviors that went undetected in previous releases, with wide-ranging positive effects on security, performance, and user experience. You should validate your content to ensure compatibility with these templating changes before upgrading to ansible-core 2.19 or Ansible 12. See the <a href="https://docs.ansible.com/projects/ansible/devel/porting_guides/porting_guide_12.html">porting guide</a> to understand where you may need to update your playbooks and roles.';

} else if (startsWith(current_url_path, "/ansible/2.9/")) {
} else if (startsWith(current_url_path, "/projects/ansible/2.9/")) {
Copy link
Contributor Author

@oraNod oraNod Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samccann Is there any reason to keep this 2.9 banner?

@oraNod oraNod marked this pull request as ready for review November 10, 2025 10:24
@oraNod oraNod requested a review from gundalow November 10, 2025 10:25
@oraNod oraNod added backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch backport-2.20 Automatically create a backport for the stable-2.20 branch labels Nov 10, 2025
@gundalow gundalow merged commit 481c896 into ansible:devel Nov 10, 2025
23 checks passed
@patchback
Copy link

patchback bot commented Nov 10, 2025 •
edited
Loading

Backport to stable-2.17: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 481c896 on top of patchback/backports/stable-2.17/481c896dca08690f268967547a800f06226f5c28/pr-3145

Backporting merged PR #3145 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it: 
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code: 
    $ git fetch upstream
$ git checkout -b patchback/backports/stable-2.17/481c896dca08690f268967547a800f06226f5c28/pr-3145 upstream/stable-2.17
  4. Now, cherry-pick PR Update banner to use RTD projects subdirs #3145 contents into that branch: 
    $ git cherry-pick -x 481c896dca08690f268967547a800f06226f5c28
    If it'll yell at you with something like fatal: Commit 481c896dca08690f268967547a800f06226f5c28 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x 481c896dca08690f268967547a800f06226f5c28
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Update banner to use RTD projects subdirs #3145 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/stable-2.17/481c896dca08690f268967547a800f06226f5c28/pr-3145
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@patchback
Copy link

patchback bot commented Nov 10, 2025 •
edited
Loading

Backport to stable-2.18: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 481c896 on top of patchback/backports/stable-2.18/481c896dca08690f268967547a800f06226f5c28/pr-3145

Backporting merged PR #3145 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it: 
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code: 
    $ git fetch upstream
$ git checkout -b patchback/backports/stable-2.18/481c896dca08690f268967547a800f06226f5c28/pr-3145 upstream/stable-2.18
  4. Now, cherry-pick PR Update banner to use RTD projects subdirs #3145 contents into that branch: 
    $ git cherry-pick -x 481c896dca08690f268967547a800f06226f5c28
    If it'll yell at you with something like fatal: Commit 481c896dca08690f268967547a800f06226f5c28 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x 481c896dca08690f268967547a800f06226f5c28
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Update banner to use RTD projects subdirs #3145 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/stable-2.18/481c896dca08690f268967547a800f06226f5c28/pr-3145
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@patchback
Copy link

patchback bot commented Nov 10, 2025 •
edited
Loading

Backport to stable-2.19: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 481c896 on top of patchback/backports/stable-2.19/481c896dca08690f268967547a800f06226f5c28/pr-3145

Backporting merged PR #3145 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it: 
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code: 
    $ git fetch upstream
$ git checkout -b patchback/backports/stable-2.19/481c896dca08690f268967547a800f06226f5c28/pr-3145 upstream/stable-2.19
  4. Now, cherry-pick PR Update banner to use RTD projects subdirs #3145 contents into that branch: 
    $ git cherry-pick -x 481c896dca08690f268967547a800f06226f5c28
    If it'll yell at you with something like fatal: Commit 481c896dca08690f268967547a800f06226f5c28 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x 481c896dca08690f268967547a800f06226f5c28
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Update banner to use RTD projects subdirs #3145 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/stable-2.19/481c896dca08690f268967547a800f06226f5c28/pr-3145
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@patchback
Copy link

patchback bot commented Nov 10, 2025 •
edited
Loading

Backport to stable-2.20: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.20/481c896dca08690f268967547a800f06226f5c28/pr-3145

Backported as #3236

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Nov 10, 2025
@oraNod @patchback
update banner to use RTD projects subdirs (#3145)
b0ded0a 
(cherry picked from commit 481c896)
@patchback patchback bot mentioned this pull request Nov 10, 2025
Merged
oraNod added a commit that referenced this pull request Nov 10, 2025
@oraNod
update banner to use RTD projects subdirs (#3145)
6b4dc6c 
(cherry picked from commit 481c896)
@oraNod oraNod mentioned this pull request Nov 10, 2025
Merged
oraNod added a commit to oraNod/ansible-documentation that referenced this pull request Nov 10, 2025
@oraNod
update banner to use RTD projects subdirs (ansible#3145)
9d0ac8c 
(cherry picked from commit 481c896)
@oraNod oraNod mentioned this pull request Nov 10, 2025
Merged
oraNod added a commit to oraNod/ansible-documentation that referenced this pull request Nov 10, 2025
@oraNod
update banner to use RTD projects subdirs (ansible#3145)
55cc06e 
(cherry picked from commit 481c896)
@oraNod oraNod mentioned this pull request Nov 10, 2025
Merged
oraNod added a commit that referenced this pull request Nov 10, 2025
@patchback @oraNod
update banner to use RTD projects subdirs (#3145) (#3236)
60536f0 
(cherry picked from commit 481c896)

Co-authored-by: Don Naro <[email protected]>
oraNod added a commit that referenced this pull request Nov 10, 2025
@oraNod
[stable-2.17] update banner to use RTD projects subdirs (#3241)
bc49f0a 
* update banner to use RTD projects subdirs (#3145)

(cherry picked from commit 481c896)

* fix urls to use RTD projects subfolder
oraNod added a commit that referenced this pull request Nov 10, 2025
@oraNod
[stable-2.18] update banner to use RTD projects subdirs (#3240)
9147a38 
* update banner to use RTD projects subdirs (#3145)

(cherry picked from commit 481c896)

* fix urls to use RTD projects subfolder
oraNod added a commit that referenced this pull request Nov 10, 2025
@oraNod
update banner to use RTD projects subdirs (#3145) (#3239)
aa87341 
(cherry picked from commit 481c896)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gundalow gundalow gundalow approved these changes

@samccann samccann Awaiting requested review from samccann

Assignees

No one assigned

Labels

backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch backport-2.20 Automatically create a backport for the stable-2.20 branch RTD migration Related to the migration of content to readthedocs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@oraNod @gundalow